Skip to content

Feat: change toy tutorial to kW units#2223

Open
BelhsanHmida wants to merge 14 commits into
mainfrom
feat/change-toy-tutorial-to-kw-units
Open

Feat: change toy tutorial to kW units#2223
BelhsanHmida wants to merge 14 commits into
mainfrom
feat/change-toy-tutorial-to-kw-units

Conversation

@BelhsanHmida

@BelhsanHmida BelhsanHmida commented Jun 5, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

  • Change flexmeasures add toy-account to create kW-scale tutorial power sensors.
  • Change the toy account day-ahead price sensor from EUR/MWh to EUR/kWh.
  • Keep tutorial price CSV values in EUR/MWh and load them with --unit EUR/MWh to demonstrate unit conversion.
  • Change toy power flow sensors and schedules from MW-scale to kW-scale.
  • Keep the toy site and battery physical power capacities in 500 kVA.
  • Change the reporter tutorial grid connection capacity from 0.5 MW to 500 kW.
  • Update toy tutorial docs, runnable tutorial scripts, and CI tutorial inputs for the new units.
  • Add regression coverage for battery and reporter toy-account units.
  • Added changelog item in documentation/changelog.rst

Look & Feel

CLI examples now show kW-scale toy assets and schedules, for example:

Created <Sensor 2: discharging, unit: kW res.: 0:15:00>
Created <Sensor 7: grid connection capacity, unit: kW res.: P1Y>

The rerun toy tutorial plots showed kW labels such as 500kW, 0kW, -500kW, and reporter headroom values around 300kW to 500kW.

Simplified schedule output:

Beliefs for Sensor 'discharging' (ID 2).
Data spans 12 hours and starts at 2026-06-05 07:00:00+01:00.
The time resolution (x-axis) is 15 minutes.

  500kW |        /\                         /\
        |       /  \                       /  \
    0kW |------/----\---------------------/----\-----
        |     /      \                   /      \
 -500kW |____/        \_________________/        \___
             06:00        09:00        12:00        15:00
             discharging (toy-battery)

Simplified reporter output:

Beliefs for Sensor 'headroom' (ID 8).
Data spans a day and starts at 2026-06-05 00:00:00+01:00.
The time resolution (x-axis) is 15 minutes.

  500kW |--------\                              /--------
  400kW |         \____                  ____/
  300kW |              \________________/
             00:00        06:00        12:00        18:00
             headroom (toy-battery)

How to test

run the Docker tutorial scripts in order against a fresh isolated stack:

./documentation/tut/scripts/run-tutorial-in-docker.sh fm1139-server-1
./documentation/tut/scripts/run-tutorial2-in-docker.sh fm1139-server-1
./documentation/tut/scripts/run-tutorial3-in-docker.sh fm1139-server-1
./documentation/tut/scripts/run-tutorial4-in-docker.sh fm1139-server-1
./documentation/tut/scripts/run-tutorial5-in-docker.sh fm1139-server-1

Further Improvements

  • Regenerate and upload the external UI screenshots in the separate FlexMeasures/screenshots repository.

Related Items

Closes #1139.

Sign-off

  • I agree to contribute to the project under Apache 2 License.
  • To the best of my knowledge, the proposed patch is not based on code under GPL or other license that is incompatible with FlexMeasures

@BelhsanHmida
cli: create toy accounts with kW-scale units
8998ce9 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
cli/tests: cover kW-scale toy account data
74fafb4 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
ci: use kW-scale toy tutorial inputs
360bac5 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
docs/scripts: run toy tutorials with kW-scale data
f0be0ca 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
docs/tutorial: show battery scheduling in kW units
9fae10c 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
docs/tutorial: align follow-on examples with kW units
9f7a6f9 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
docs: add changelog entry
1aa0426 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@Flix6x Flix6x changed the title Feat: change toy tutorial to kw units Feat: change toy tutorial to kW units Jun 5, 2026
Flix6x
Flix6x requested changes Jun 5, 2026
View reviewed changes

@Flix6x Flix6x left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, my two main comments are:

  • to actually not change the toy battery and site power capacities from 500 kVA to 500 kW, and
  • to keep the example price data in EUR/MWh, but just scale it to the EUR/kWh sensor unit by explicitly setting the --unit EUR/MWh CLI option of flexmeasures add beliefs.

Also a question: are there screenshots that would need to be updated in https://github.com/FlexMeasures/screenshots (maybe making FlexMeasures/screenshots#8 obsolete by now)?

Comment thread documentation/tut/scripts/run-tutorial-in-docker.sh Outdated
Comment thread .github/workflows/build.yml Outdated
Comment thread documentation/tut/toy-example-setup.rst
Comment thread flexmeasures/cli/data_add.py Outdated
Comment thread flexmeasures/cli/tests/test_data_add_fresh_db.py
@Flix6x Flix6x added documentation Improvements or additions to documentation Units Deals with unit conversion labels Jun 5, 2026
@Flix6x Flix6x added this to the 1.0.0 milestone Jun 5, 2026
@BelhsanHmida
docs/tutorial: import toy prices as EUR per MWh
03bc4da 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
ci: import toy prices as EUR per MWh
e4a89c8 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
docs/tests: keep toy site capacity in kVA
d3c2d82 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
docs/tests: keep toy battery capacity in kVA
1be8dea 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
tests: explain toy schedule power bounds
d90941a 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida

BelhsanHmida commented Jun 5, 2026

Copy link
Copy Markdown
Contributor Author

Nice, my two main comments are:

  • to actually not change the toy battery and site power capacities from 500 kVA to 500 kW, and
  • to keep the example price data in EUR/MWh, but just scale it to the EUR/kWh sensor unit by explicitly setting the --unit EUR/MWh CLI option of flexmeasures add beliefs.

Also a question: are there screenshots that would need to be updated in https://github.com/FlexMeasures/screenshots (maybe making FlexMeasures/screenshots#8 obsolete by now)?

yes that pr is obsolete.

Flix6x
Flix6x approved these changes Jun 5, 2026
View reviewed changes

@Flix6x Flix6x left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Unless screenshots still need to be updated, I approve.

Comment thread flexmeasures/cli/tests/test_data_add_fresh_db.py
@BelhsanHmida

BelhsanHmida commented Jun 8, 2026 •
edited by Flix6x
Loading

Copy link
Copy Markdown
Contributor Author

Thanks. Unless screenshots still need to be updated, I approve.

Yes there are photos to be updated. I will make the flexmeasures-screenshot PR and link it to this.

@BelhsanHmida
Merge branch 'main' into feat/change-toy-tutorial-to-kw-units
fe8a95e 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>

# Conflicts:
#	documentation/changelog.rst
#	flexmeasures/cli/tests/test_data_add_fresh_db.py
@BelhsanHmida
docs: restore main whitespace after merge
c771724 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@nhoening

nhoening commented Jul 6, 2026

Copy link
Copy Markdown
Member

@BelhsanHmida is this PR mergeable now?

@BelhsanHmida

BelhsanHmida commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

@BelhsanHmida is this PR mergeable now?

I have three more screenshots to generate for the screenshots repo then this can be merged once that's merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Flix6x Flix6x Flix6x approved these changes

Assignees

@BelhsanHmida BelhsanHmida

Labels

documentation Improvements or additions to documentation Units Deals with unit conversion

Projects

None yet

Milestone

1.0.0

Development

Successfully merging this pull request may close these issues.

Redo the toy tutorial for scheduling a battery with kW and kWh units

3 participants

@BelhsanHmida @nhoening @Flix6x